ex_figures v0.1.1 ExFigures.Products View Source

The /products resource provides access to product meta data in a variety of ways.

Link to this section Summary

Types

Most places you can be given products you can also ask for additional data from the products by appending the meta: true to your request.

Represents user products query arguments

Represents products searching query arguments

Represents update product query argument

Functions

Getting a product by its Appfigures ID

Getting a product by its id in the store

Listing all of your products

Searching for products. The Public Data API add-on is required for this route. Scope: This resource requires the public:read scope.

Link to this section Types

Link to this type

meta_opt() View Source
meta_opt() :: {:meta, boolean()}

Most places you can be given products you can also ask for additional data from the products by appending the meta: true to your request.

Link to this type

mine_opt() View Source
mine_opt() :: {:store, binary()} | meta_opt()

Represents user products query arguments

Link to this type

search_opt() View Source
search_opt() ::
  {:filter, binary()} | {:page, integer()} | {:count, integer()} | meta_opt()

Represents products searching query arguments

Link to this type

update_attrs() View Source
update_attrs() :: %{
  source: %{optional(:active) => boolean(), optional(:hidden) => boolean()}
}

Represents update product query argument

Link to this section Functions

Link to this function

get_by_appfigures_id(client, appfigures_id) View Source
get_by_appfigures_id(ExFigures.t(), binary()) :: ExFigures.result()

Getting a product by its Appfigures ID

Link to this function

get_by_store_id(client, store, store_id) View Source
get_by_store_id(ExFigures.t(), binary(), binary()) :: ExFigures.result()

Getting a product by its id in the store

Link to this function

list_mine(client, query \\ []) View Source
list_mine(ExFigures.t(), [mine_opt()]) :: ExFigures.result()

Listing all of your products

Query options:

  • :store - Filter to only show products from a given store. apple, google_play, amazon_appstore are some valid examples.
Link to this function

search(client, term, query \\ []) View Source

Searching for products. The Public Data API add-on is required for this route. Scope: This resource requires the public:read scope.

Query options:

  • :term - The name of an app or a developer. Prefix with @name= or @developer= if you’d like to search that field only.
  • :filter - Filter to apply to the results: one of ios, mac, google, amazon. Defaults to showing all results
  • :page - Page of results to show. Defaults to the first page
  • :count - Number of results to show in a page. Defaults to 25
Link to this function

update(client, appfigures_id, attrs) View Source

Updating products

Attribures:

  • :source

    • :active - true/false
    • :hidden - true/false