starkinfra 0.1.0 → 0.2.0

data/lib/issuingholder/issuingholder.rb

@@ -1,14 +1,18 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # IssuingHolder object
   #
   # The IssuingHolder describes a card holder that may group several cards.
   #
+  # When you initialize a IssuingHolder, the entity will not be automatically
+  # created in the Stark Infra API. The 'create' function sends the objects
+  # to the Stark Infra API and returns the created object.
+  #
   # ## Parameters (required):
   # - name [string]: card holder name.
   # - tax_id [string]: card holder tax ID
@@ -16,7 +20,7 @@ module StarkInfra
   #
   # ## Parameters (optional):
   # - rules [list of IssuingRule objects, default nil]: [EXPANDABLE] list of holder spending rules.
-  # - tags [list of strings, default []]: list of strings for tagging. ex: ['travel', 'food']
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ['travel', 'food']
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when IssuingHolder is created. ex: '5656565656565656'
@@ -24,17 +28,17 @@ module StarkInfra
   # - updated [DateTime]: latest update datetime for the IssuingHolder. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class IssuingHolder < StarkInfra::Utils::Resource
-    attr_reader :id, :name, :tax_id, :external_id, :status, :rules, :tags, :updated, :created
+    attr_reader :id, :name, :tax_id, :external_id, :rules, :tags, :status, :updated, :created
     def initialize(
-      name:, tax_id:, external_id:, id: nil, status: nil, rules: nil, tags: nil, updated: nil, created: nil
+      name:, tax_id:, external_id:, rules: nil, tags: nil, id: nil, status: nil, updated: nil, created: nil
     )
       super(id)
       @name = name
       @tax_id = tax_id
       @external_id = external_id
-      @status = status
       @rules = StarkInfra::IssuingRule.parse_rules(rules)
       @tags = tags
+      @status = status
       @created = StarkInfra::Utils::Checks.check_datetime(created)
       @updated = StarkInfra::Utils::Checks.check_datetime(updated)
     end
@@ -47,12 +51,13 @@ module StarkInfra
     # - holders [list of IssuingHolder objects]: list of IssuingHolder objects to be created in the API
     #
     # ## Parameters (optional):
+    # - expand [list of strings, default nil]: fields to expand information. Options: ['rules']
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
     # - list of IssuingHolder objects with updated attributes
-    def self.create(holders:, user: nil)
-      StarkInfra::Utils::Rest.post(entities: holders, user: user, **resource)
+    def self.create(holders:, expand: nil, user: nil)
+      StarkInfra::Utils::Rest.post(entities: holders, expand: expand, user: user, **resource)
     end
 
     # # Retrieve a specific IssuingHolder
@@ -193,9 +198,9 @@ module StarkInfra
             name: json['name'],
             tax_id: json['tax_id'],
             external_id: json['external_id'],
-            status: json['status'],
             rules: json['rules'],
             tags: json['tags'],
+            status: json['status'],
             updated: json['updated'],
             created: json['created']
           )

data/lib/issuingholder/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
+require_relative('issuingholder')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
-require_relative('issuingholder')
+require_relative('../utils/resource')
 
 module StarkInfra
   class IssuingHolder

data/lib/issuinginvoice/issuinginvoice.rb

@@ -1,42 +1,53 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # IssuingInvoice object
   #
   # The IssuingInvoice objects created in your Workspace load your Issuing balance when paid.
   #
+  # When you initialize a IssuingInvoice, the entity will not be automatically
+  # created in the Stark Infra API. The 'create' function sends the objects
+  # to the Stark Infra API and returns the created object.
+  #
   # ## Parameters (required):
   # - amount [integer]: IssuingInvoice value in cents. ex: 1234 (= R$ 12.34)
   #
   # ## Parameters (optional):
   # - tax_id [string, default sub-issuer tax ID]: payer tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
   # - name [string, default sub-issuer name]: payer name. ex: 'Iron Bank S.A.'
-  # - tags [list of strings, default []]: list of strings for tagging. ex: ['travel', 'food']
+  # - tags [list of strings, default nil]: list of strings for tagging. ex: ['travel', 'food']
   #
   # ## Attributes (return-only):
   # - id [string]: unique id returned when IssuingInvoice is created. ex: '5656565656565656'
+  # - brcode [string]: BR Code for the Invoice payment. ex: '00020101021226930014br.gov.bcb.pix2571brcode-h.development.starkinfra.com/v2/d7f6546e194d4c64a153e8f79f1c41ac5204000053039865802BR5925Stark Bank S.A. - Institu6009Sao Paulo62070503***63042109'
+  # - due [DateTime, Date or string]: Invoice due and expiration date in UTC ISO format. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0), Date.new(2020, 3, 10) or '2020-03-10T10:30:00.000000+00:00'
+  # - link [string]: public Invoice webpage URL. ex: 'https://starkbank-card-issuer.development.starkbank.com/invoicelink/d7f6546e194d4c64a153e8f79f1c41ac'
   # - status [string]: current IssuingInvoice status. ex: 'created', 'expired', 'overdue', 'paid'
   # - issuing_transaction_id [string]: ledger transaction ids linked to this IssuingInvoice. ex: 'issuing-invoice/5656565656565656'
   # - updated [DateTime]: latest update datetime for the IssuingInvoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - created [DateTime]: creation datetime for the IssuingInvoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class IssuingInvoice < StarkInfra::Utils::Resource
-    attr_reader :amount, :id, :name, :tax_id, :status, :issuing_transaction_id, :tags, :updated, :created
+    attr_reader :id, :amount, :tax_id, :name, :tags, :brcode, :due, :link, :status, :issuing_transaction_id, :updated, :created
     def initialize(
-      amount:, id: nil, name: nil, tax_id: nil, status: nil, issuing_transaction_id: nil, tags: nil, updated: nil, created: nil
+      amount:, id: nil, tax_id: nil, name: nil, tags: nil, brcode: nil, due: nil, link: nil, status: nil, issuing_transaction_id: nil,
+      updated: nil, created: nil
     )
       super(id)
       @amount = amount
-      @name = name
       @tax_id = tax_id
+      @name = name
+      @tags = tags
+      @brcode = brcode
+      @due = due
+      @link = link
       @status = status
       @issuing_transaction_id = issuing_transaction_id
-      @tags = tags
-      @created = StarkInfra::Utils::Checks.check_datetime(created)
       @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
     end
 
     # # Create an IssuingInvoice
@@ -137,11 +148,14 @@ module StarkInfra
           IssuingInvoice.new(
             id: json['id'],
             amount: json['amount'],
-            name: json['name'],
             tax_id: json['tax_id'],
+            name: json['name'],
+            tags: json['tags'],
+            brcode: json['brcode'],
+            due: json['due'],
+            link: json['link'],
             status: json['status'],
             issuing_transaction_id: json['issuing_transaction_id'],
-            tags: json['tags'],
             updated: json['updated'],
             created: json['created']
           )

data/lib/issuinginvoice/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
-require_relative('../utils/checks')
 require_relative('issuinginvoice')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   class IssuingInvoice

data/lib/{issuingbin/issuingbin.rb → issuingproduct/issuingproduct.rb}

@@ -1,45 +1,43 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
-  # # IssuingBin object
+  # # IssuingProduct object
   #
-  # The IssuingBin object displays information of BINs registered to your Workspace.
-  # They represent a group of cards that begin with the same numbers (BIN) and offer the same product to end customers.
+  # The IssuingProduct object displays information of avaliable card products registered to your Workspace.
+  # They represent a group of cards that begin with the same numbers (id) and offer the same product to end customers.
   #
   # ## Attributes (return-only):
-  # - id [string]: unique BIN number registered within the card network. ex: '53810200'
+  # - id [string]: unique card product number (BIN) registered within the card network. ex: '53810200'
   # - network [string]: card network flag. ex: 'mastercard'
-  # - settlement [string]: settlement type. ex: 'credit'
-  # - category [string]: purchase category. ex: 'prepaid'
-  # - client [string]: client type. ex: 'business'
-  # - created [DateTime]: creation datetime for the IssuingBin. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  # - updated [DateTime]: latest update datetime for the IssuingBin. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
-  class IssuingBin < StarkInfra::Utils::Resource
-    attr_reader :id, :network, :settlement, :category, :client, :updated, :created
-    def initialize(id: nil, network: nil, settlement: nil, category: nil, client: nil, updated: nil, created: nil)
+  # - funding_type [string]: type of funding used for payment. ex: 'credit', 'debit'
+  # - holder_type [string]: holder type. ex: 'business', 'individual'
+  # - code [string]: internal code from card flag informing the product. ex: 'MRW', 'MCO', 'MWB', 'MCS'
+  # - created [DateTime]: creation datetime for the IssuingProduct. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class IssuingProduct < StarkInfra::Utils::Resource
+    attr_reader :id, :network, :funding_type, :holder_type, :code, :created
+    def initialize(id: nil, network: nil, funding_type: nil, holder_type: nil, code: nil, created: nil)
       super(id)
       @network = network
-      @settlement = settlement
-      @category = category
-      @client = client
-      @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+      @funding_type = funding_type
+      @holder_type = holder_type
+      @code = code
       @created = StarkInfra::Utils::Checks.check_datetime(created)
     end
 
-    # # Retrieve the IssuingBin object
+    # # Retrieve IssuingProducts
     #
-    # Receive a generator of IssuingBin objects previously registered in the Stark Infra API
+    # Receive a generator of available IssuingProduct objects previously registered to your workspace
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - generator of IssuingBin objects with updated attributes
+    # - generator of IssuingProduct objects with updated attributes
     def self.query(limit: nil, user: nil)
       StarkInfra::Utils::Rest.get_stream(
         limit: limit,
@@ -48,9 +46,9 @@ module StarkInfra
       )
     end
 
-    # # Retrieve paged IssuingBins
+    # # Retrieve paged IssuingProducts
     #
-    # Receive a list of up to 100 IssuingBin objects previously registered in the Stark Infra API and the cursor to the next page.
+    # Receive a list of up to 100 IssuingProduct objects previously registered to your workspace and the cursor to the next page.
     #
     # ## Parameters (optional):
     # - cursor [string, default nil]: cursor returned on the previous page function call.
@@ -58,8 +56,8 @@ module StarkInfra
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call
     #
     # ## Return:
-    # - list of IssuingBin objects with updated attributes
-    # - cursor to retrieve the next page of IssuingBin objects
+    # - list of IssuingProduct objects with updated attributes
+    # - cursor to retrieve the next page of IssuingProduct objects
     def self.page(cursor: nil, limit: nil, user: nil)
       StarkInfra::Utils::Rest.get_page(
         cursor: cursor,
@@ -71,15 +69,14 @@ module StarkInfra
 
     def self.resource
       {
-        resource_name: 'IssuingBin',
+        resource_name: 'IssuingProduct',
         resource_maker: proc { |json|
-          IssuingBin.new(
+          IssuingProduct.new(
             id: json['id'],
             network: json['network'],
-            settlement: json['settlement'],
-            category: json['category'],
-            client: json['client'],
-            updated: json['updated'],
+            funding_type: json['funding_type'],
+            holder_type: json['holder_type'],
+            code: json['code'],
             created: json['created']
           )
         }

data/lib/issuingpurchase/issuingpurchase.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # IssuingPurchase object
@@ -14,6 +14,7 @@ module StarkInfra
   # - holder_name [string]: card holder name. ex: 'Tony Stark'
   # - card_id [string]: unique id returned when IssuingCard is created. ex: '5656565656565656'
   # - card_ending [string]: last 4 digits of the card number. ex: '1234'
+  # - purpose [string]: purchase purpose. ex: 'purchase'
   # - amount [integer]: IssuingPurchase value in cents. Minimum = 0. ex: 1234 (= R$ 12.34)
   # - tax [integer]: IOF amount taxed for international purchases. ex: 1234 (= R$ 12.34)
   # - issuer_amount [integer]: issuer amount. ex: 1234 (= R$ 12.34)
@@ -29,32 +30,42 @@ module StarkInfra
   # - merchant_name [string]: merchant name. ex: 'Google Cloud Platform'
   # - merchant_fee [integer]: fee charged by the merchant to cover specific costs, such as ATM withdrawal logistics, etc. ex: 200 (= R$ 2.00)
   # - wallet_id [string]: virtual wallet ID. ex: '5656565656565656'
-  # - method_code [string]: method code. ex: 'chip', 'token', 'server', 'manual', 'magstripe' or 'contactless'
+  # - method_code [string]: method code. Options: 'chip', 'token', 'server', 'manual', 'magstripe' or 'contactless'
   # - score [float]: internal score calculated for the authenticity of the purchase. nil in case of insufficient data. ex: 7.6
-  # - issuing_transaction_ids [string]: ledger transaction ids linked to this Purchase
-  # - end_to_end_id [string]: Unique id used to identify the transaction through all of its life cycle, even before the purchase is denied or accepted and gets its usual id. Example: endToEndId='679cd385-642b-49d0-96b7-89491e1249a5'
-  # - status [string]: current IssuingCard status. ex: 'approved', 'canceled', 'denied', 'confirmed', 'voided'
+  # - end_to_end_id [string]: Unique id used to identify the transaction through all of its life cycle, even before the purchase is denied or approved and gets its usual id. ex: '679cd385-642b-49d0-96b7-89491e1249a5'
   # - tags [string]: list of strings for tagging returned by the sub-issuer during the authorization. ex: ['travel', 'food']
-  # - created [DateTime]: creation datetime for the IssuingPurchase. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - zip_code [string]: zip code of the merchant location. ex: '02101234'
+  #
+  # ## Attributes (IssuingPurchase only):
+  # - issuing_transaction_ids [string]: ledger transaction ids linked to this Purchase
+  # - status [string]: current IssuingCard status. Options: 'approved', 'canceled', 'denied', 'confirmed', 'voided'
   # - updated [DateTime]: latest update datetime for the IssuingPurchase. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - created [DateTime]: creation datetime for the IssuingPurchase. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  #
+  # ## Attributes (authorization request only):
+  # - is_partial_allowed [bool]: true if the merchant allows partial purchases. ex: False
+  # - card_tags [list of strings]: tags of the IssuingCard responsible for this purchase. ex: ['travel', 'food']
+  # - holder_tags [list of strings]: tags of the IssuingHolder responsible for this purchase. ex: ['technology', 'john snow']
   class IssuingPurchase < StarkInfra::Utils::Resource
-    attr_reader :id, :holder_name, :card_id, :card_ending, :amount, :tax, :issuer_amount, :issuer_currency_code,
+    attr_reader :id, :holder_name, :card_id, :card_ending, :purpose, :amount, :tax, :issuer_amount, :issuer_currency_code,
                 :issuer_currency_symbol, :merchant_amount, :merchant_currency_code, :merchant_currency_symbol,
                 :merchant_category_code, :merchant_country_code, :acquirer_id, :merchant_id, :merchant_name,
-                :merchant_fee, :wallet_id, :method_code, :score, :issuing_transaction_ids, :end_to_end_id, :status,
-                :tags, :updated, :created
+                :merchant_fee, :wallet_id, :method_code, :score, :end_to_end_id, :tags, :zip_code,
+                :issuing_transaction_ids, :status, :updated, :created, :is_partial_allowed, :card_tags, :holder_tags
 
     def initialize(
-      id: nil, holder_name: nil, card_id: nil, card_ending: nil, amount: nil, tax: nil, issuer_amount: nil,
+      id: nil, holder_name: nil, card_id: nil, card_ending: nil, purpose: nil, amount: nil, tax: nil, issuer_amount: nil,
       issuer_currency_code: nil, issuer_currency_symbol: nil, merchant_amount: nil, merchant_currency_code: nil,
       merchant_currency_symbol: nil, merchant_category_code: nil, merchant_country_code: nil, acquirer_id: nil,
       merchant_id: nil, merchant_name: nil, merchant_fee: nil, wallet_id: nil, method_code: nil, score: nil,
-      issuing_transaction_ids: nil, end_to_end_id: nil, status: nil, tags: nil, updated: nil, created: nil
+      end_to_end_id: nil, tags: nil, zip_code: nil, issuing_transaction_ids: nil, status: nil, updated: nil, created: nil,
+      is_partial_allowed: nil, card_tags:nil, holder_tags:nil
     )
       super(id)
       @holder_name = holder_name
       @card_id = card_id
       @card_ending = card_ending
+      @purpose = purpose
       @amount = amount
       @tax = tax
       @issuer_amount = issuer_amount
@@ -72,12 +83,17 @@ module StarkInfra
       @wallet_id = wallet_id
       @method_code = method_code
       @score = score
-      @issuing_transaction_ids = issuing_transaction_ids
       @end_to_end_id = end_to_end_id
-      @status = status
       @tags = tags
-      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @zip_code = zip_code
+      @issuing_transaction_ids = issuing_transaction_ids
+      @status = status
       @updated = StarkInfra::Utils::Checks.check_datetime(updated)
+      @created = StarkInfra::Utils::Checks.check_datetime(created)
+      @is_partial_allowed = is_partial_allowed
+      @card_tags = card_tags
+      @holder_tags = holder_tags
+
     end
 
     # # Retrieve a specific IssuingPurchase
@@ -105,9 +121,9 @@ module StarkInfra
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
     # - after [Date or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 09)
     # - before [Date or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
-    # - end_to_end_ids [list of strings, default []]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
-    # - holder_ids [list of strings, default []]: card holder IDs. ex: ['5656565656565656', '4545454545454545']
-    # - card_ids [list of strings, default []]: card  IDs. ex: ['5656565656565656', '4545454545454545']
+    # - end_to_end_ids [list of strings, default nil]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
+    # - holder_ids [list of strings, default nil]: card holder IDs. ex: ['5656565656565656', '4545454545454545']
+    # - card_ids [list of strings, default nil]: card  IDs. ex: ['5656565656565656', '4545454545454545']
     # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['approved', 'canceled', 'denied', 'confirmed', 'voided']
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
     #
@@ -141,9 +157,9 @@ module StarkInfra
     # - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35
     # - after [Date or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
     # - before [Date or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
-    # - end_to_end_ids [list of strings, default []]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
-    # - holder_ids [list of strings, default []]: card holder IDs. ex: ['5656565656565656', '4545454545454545']
-    # - card_ids [list of strings, default []]: card  IDs. ex: ['5656565656565656', '4545454545454545']
+    # - end_to_end_ids [list of strings, default nil]: central bank's unique transaction ID. ex: 'E79457883202101262140HHX553UPqeq'
+    # - holder_ids [list of strings, default nil]: card holder IDs. ex: ['5656565656565656', '4545454545454545']
+    # - card_ids [list of strings, default nil]: card  IDs. ex: ['5656565656565656', '4545454545454545']
     # - status [list of strings, default nil]: filter for status of retrieved objects. ex: ['approved', 'canceled', 'denied', 'confirmed', 'voided']
     # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
     #
@@ -169,6 +185,61 @@ module StarkInfra
       )
     end
 
+    # # Create a single verified IssuingPurchase authorization request from a content string
+    #
+    # Use this method to parse and verify the authenticity of the authorization request received at the informed endpoint.
+    # Authorization requests are posted to your registered endpoint whenever IssuingPurchases are received.
+    # They present IssuingPurchase data that must be analyzed and answered with approval or declination.
+    # If the provided digital signature does not check out with the StarkInfra public key, a stark.exception.InvalidSignatureException will be raised.
+    # If the authorization request is not answered within 2 seconds or is not answered with an HTTP status code 200 the
+    # IssuingPurchase will go through the pre-configured stand-in validation.
+    #
+    # ## Parameters (required):
+    # - content [string]: response content from request received at user endpoint (not parsed)
+    # - signature [string]: base-64 digital signature received at response header 'Digital-Signature'
+    #
+    # # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - Parsed IssuingPurchase object
+    def self.parse(content:, signature:, user: nil)
+      StarkInfra::Utils::Parse.parse_and_verify(
+        content: content,
+        signature: signature,
+        user: user,
+        key: nil,
+        **resource
+      )
+    end
+
+    # # Helps you respond to a IssuingPurchase authorization request
+    #
+    # ## Parameters (required):
+    # - status [string]: sub-issuer response to the authorization. ex: 'approved' or 'denied'
+    #
+    # ## Parameters (conditionally required):
+    # - reason [string]: denial reason. Options: 'other', 'blocked', 'lostCard', 'stolenCard', 'invalidPin', 'invalidCard', 'cardExpired', 'issuerError', 'concurrency', 'standInDenial', 'subIssuerError', 'invalidPurpose', 'invalidZipCode', 'invalidWalletId', 'inconsistentCard', 'settlementFailed', 'cardRuleMismatch', 'invalidExpiration', 'prepaidInstallment', 'holderRuleMismatch', 'insufficientBalance', 'tooManyTransactions', 'invalidSecurityCode', 'invalidPaymentMethod', 'confirmationDeadline', 'withdrawalAmountLimit', 'insufficientCardLimit', 'insufficientHolderLimit'
+    #
+    # # ## Parameters (optional):
+    # - amount [integer, default nil]: amount in cents that was authorized. ex: 1234 (= R$ 12.34)
+    # - tags [list of strings, default nil]: tags to filter retrieved object. ex: ['tony', 'stark']
+    #
+    # ## Return:
+    # - Dumped JSON string that must be returned to us on the IssuingPurchase request
+    def self.response(
+      status:, reason:, amount:, tags:
+    )
+      params = {
+        'status': status,
+        'reason': reason,
+        'amount': amount,
+        'tags': tags
+      }
+
+      params.to_json
+    end
+
     def self.resource
       {
         resource_name: 'IssuingPurchase',
@@ -178,6 +249,7 @@ module StarkInfra
             holder_name: json['holder_name'],
             card_id: json['card_id'],
             card_ending: json['card_ending'],
+            purpose: json['purpose'],
             amount: json['amount'],
             tax: json['tax'],
             issuer_amount: json['issuer_amount'],
@@ -195,12 +267,16 @@ module StarkInfra
             wallet_id: json['wallet_id'],
             method_code: json['method_code'],
             score: json['score'],
-            issuing_transaction_ids: json['issuing_transaction_ids'],
             end_to_end_id: json['end_to_end_id'],
-            status: json['status'],
             tags: json['tags'],
+            zip_code: json['zip_code'],
+            issuing_transaction_ids: json['issuing_transaction_ids'],
+            status: json['status'],
             updated: json['updated'],
-            created: json['created']
+            created: json['created'],
+            is_partial_allowed: json['is_partial_allowed'],
+            card_tags: json['card_tags'],
+            holder_tags: json['holder_tags']
           )
         }
       }

data/lib/issuingpurchase/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
 require_relative('issuingpurchase')
+require_relative('../utils/resource')
 
 module StarkInfra
   class IssuingPurchase

data/lib/issuingrule/issuingrule.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../utils/resource')
 require_relative('../utils/rest')
 require_relative('../utils/checks')
+require_relative('../utils/resource')
 
 module StarkInfra
   # # IssuingRule object
@@ -12,33 +12,79 @@ module StarkInfra
   # ## Parameters (required):
   # - name [string]: rule name. ex: 'Travel' or 'Food'
   # - amount [integer]: maximum amount that can be spent in the informed interval. ex: 200000 (= R$ 2000.00)
+  #
   # ## Parameters (optional):
-  # - id [string, default nil]: unique id returned when Rule is created. ex: '5656565656565656'
+  # - id [string, default nil]: unique id returned when an IssuingRule is created, used to update a specific IssuingRule. ex: '5656565656565656'
   # - interval [string, default 'lifetime']: interval after which the rule amount counter will be reset to 0. ex: 'instant', 'day', 'week', 'month', 'year' or 'lifetime'
   # - currency_code [string, default 'BRL']: code of the currency that the rule amount refers to. ex: 'BRL' or 'USD'
-  # - categories [list of strings, default []]: merchant categories accepted by the rule. ex: ['eatingPlacesRestaurants', 'travelAgenciesTourOperators']
-  # - countries [list of strings, default []]: countries accepted by the rule. ex: ['BRA', 'USA']
-  # - methods [list of strings, default []]: card purchase methods accepted by the rule. ex: ['chip', 'token', 'server', 'manual', 'magstripe', 'contactless']
+  # - categories [list of MerchantCategories, default nil]: merchant categories accepted by the rule. ex: [MerchantCategory(code='fastFoodRestaurants')]
+  # - countries [list of MerchantCountries, default nil]: countries accepted by the rule. ex: [MerchantCountry(code='BRA')]
+  # - methods [list of CardMethods, default nil]: card purchase methods accepted by the rule. ex: [CardMethod(code='magstripe')]
+  #
   # ## Attributes (expanded return-only):
   # - counter_amount [integer]: current rule spent amount. ex: 1000
   # - currency_symbol [string]: currency symbol. ex: 'R$'
   # - currency_name [string]: currency name. ex: 'Brazilian Real'
   class IssuingRule < StarkInfra::Utils::Resource
-    attr_reader :name, :interval, :amount, :currency_code, :counter_amount, :currency_name, :currency_symbol, :categories, :countries, :methods
-    def initialize(name:, amount:, id: nil, interval: nil, currency_code: nil, counter_amount: nil, currency_name: nil,
-      currency_symbol: nil, categories: nil, countries: nil, methods: nil
+    attr_reader :name, :interval, :amount, :currency_code, :counter_amount, :currency_name, :currency_symbol,
+                :categories, :countries, :methods
+    def initialize(
+      name:, amount:, id: nil, interval: nil, currency_code: nil, categories: nil, countries: nil, methods: nil,
+      counter_amount: nil, currency_symbol: nil, currency_name: nil
     )
       super(id)
       @name = name
-      @interval = interval
       @amount = amount
+      @interval = interval
       @currency_code = currency_code
+      @categories = IssuingRule.parse_categories(categories)
+      @countries = IssuingRule.parse_categories(countries)
+      @methods = IssuingRule.parse_categories(methods)
       @counter_amount = counter_amount
-      @currency_name = currency_name
       @currency_symbol = currency_symbol
-      @categories = categories
-      @countries = countries
-      @methods = methods
+      @currency_name = currency_name
+    end
+
+    def self.parse_categories(categories)
+      resource_maker = StarkInfra::MerchantCategory.resource[:resource_maker]
+      return categories if categories.nil?
+
+      parsed_categories = []
+      categories.each do |category|
+        unless category.is_a? MerchantCategory
+          category = StarkInfra::Utils::API.from_api_json(resource_maker, category)
+        end
+        parsed_categories << category
+      end
+      parsed_categories
+    end
+
+    def self.parse_countries(countries)
+      resource_maker = StarkInfra::MerchantCountry.resource[:resource_maker]
+      return countries if countries.nil?
+
+      parsed_countries = []
+      countries.each do |country|
+        unless country.is_a? MerchantCountry
+          country = StarkInfra::Utils::API.from_api_json(resource_maker, country)
+        end
+        parsed_countries << country
+      end
+      parsed_countries
+    end
+
+    def self.parse_methods(methods)
+      resource_maker = StarkInfra::CardMethod.resource[:resource_maker]
+      return methods if methods.nil?
+
+      parsed_methods = []
+      methods.each do |method|
+        unless method.is_a? CardMethod
+          method = StarkInfra::Utils::API.from_api_json(resource_maker, method)
+        end
+        parsed_methods << method
+      end
+      parsed_methods
     end
 
     def self.parse_rules(rules)
@@ -61,15 +107,15 @@ module StarkInfra
         resource_maker: proc { |json|
           IssuingRule.new(
             name: json['name'],
-            interval: json['interval'],
             amount: json['amount'],
+            interval: json['interval'],
             currency_code: json['currency_code'],
-            counter_amount: json['counter_amount'],
-            currency_name: json['currency_name'],
-            currency_symbol: json['currency_symbol'],
             categories: json['categories'],
             countries: json['countries'],
-            methods: json['methods']
+            methods: json['methods'],
+            counter_amount: json['counter_amount'],
+            currency_symbol: json['currency_symbol'],
+            currency_name: json['currency_name']
           )
         }
       }