transferzero-sdk 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67d5893020d507b8a392d04e04d4dc4af5098e459d430d89f253245e70cdc188
-  data.tar.gz: 7dbbcaa2a8eff3d52bd2d2fcadcd93e3bd9adf42a75be0846009457e81ec31ca
+  metadata.gz: f333393e130ce032c7ae5f25df97e719a671e3f0071aaef40c6c67ad81295473
+  data.tar.gz: 556e231d7edf40381c86bf3dadcf3b3559d9c799976d1f7a4d2ea69e7428094c
 SHA512:
-  metadata.gz: 576a248ecae25fef80bc23b7e5fb61d3a68116ababe69751041870371a9cb89e4e7703ef6c9a3b79989c83eabcc18889f68c0ddd8f3ef26d3615beb5cba33bf9
-  data.tar.gz: 5a0d7d0381cf92e9928c9715a19d19bdad73e773c7af978e268143f0ad3e478005c20787aad199cd0719f6edcc4ea4a0d91053929df10e5312ba2d5b11f6e0b1
+  metadata.gz: '0100867ae3b2c304d8914632fcccbaf8312e3d16a65dc136c76f868ef3fabd43479b13aeb2aac5323ca18c83ce8504cc6693d289cee1408b8ea868a746ca16bc'
+  data.tar.gz: a9b1c802ff472b829eca858a92d2a252b41ee163d28eb50c740d778c7aa86cf4fef5a48a876cb028e37ca4e4c3c6378826d7663d5c87d58ca0aec7056f680e12

data/README.md

@@ -7,7 +7,7 @@ Reference documentation for the TransferZero API V1
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 1.6.0
+- Package version: 1.7.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 For more information, please visit:
@@ -31,15 +31,15 @@ gem build transferzero-sdk.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./transferzero-sdk-1.6.0.gem
+gem install ./transferzero-sdk-1.7.0.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.6.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.7.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'transferzero-sdk', '~> 1.6.0'
+    gem 'transferzero-sdk', '~> 1.7.0'
 
 ### Install from Git
 
@@ -199,6 +199,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodDetails](docs/PayoutMethodDetails.md)
  - [TransferZero::PayoutMethodDetailsBTC](docs/PayoutMethodDetailsBTC.md)
  - [TransferZero::PayoutMethodDetailsBalance](docs/PayoutMethodDetailsBalance.md)
+ - [TransferZero::PayoutMethodDetailsGBPBank](docs/PayoutMethodDetailsGBPBank.md)
  - [TransferZero::PayoutMethodDetailsGHSBank](docs/PayoutMethodDetailsGHSBank.md)
  - [TransferZero::PayoutMethodDetailsIBAN](docs/PayoutMethodDetailsIBAN.md)
  - [TransferZero::PayoutMethodDetailsMADCash](docs/PayoutMethodDetailsMADCash.md)

data/docs/Document.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **upload** | **String** | Base64 encoded data uri of an image/pdf file or a fully qualified url | 
+**url** | **String** | URL of the document location | [optional] 
 **upload_file_name** | **String** | Name of the upload | 
 **metadata** | [**Object**](.md) | Metadata of document | [optional] 
 **upload_content_type** | **String** |  | [optional] 
@@ -22,6 +23,7 @@ Name | Type | Description | Notes
 require 'TransferZero'
 
 instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg...lFTkSuQmCC,
+                                 url: https://bitpesa-documents.amazonaws.com/document.pdf,
                                  upload_file_name: example.png,
                                  metadata: {},
                                  upload_content_type: image/png,

data/docs/PayoutMethodDetails.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **iban** | **String** |  | 
 **bank_name** | **String** |  | 
 **bank_country** | **String** |  | 
+**sort_code** | **String** |  | [optional] 
 **bic** | **String** |  | [optional] 
 **sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
 **sender_identity_card_id** | **String** |  | 
@@ -42,6 +43,7 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
                                  iban: null,
                                  bank_name: null,
                                  bank_country: null,
+                                 sort_code: null,
                                  bic: null,
                                  sender_identity_card_type: null,
                                  sender_identity_card_id: null,

data/docs/PayoutMethodDetailsGBPBank.md

@@ -0,0 +1,29 @@
+# TransferZero::PayoutMethodDetailsGBPBank
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**bank_name** | **String** |  | [optional] 
+**bank_account** | **String** |  | [optional] 
+**sort_code** | **String** |  | [optional] 
+**iban** | **String** |  | [optional] 
+**bic** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsGBPBank.new(first_name: null,
+                                 last_name: null,
+                                 bank_name: null,
+                                 bank_account: null,
+                                 sort_code: null,
+                                 iban: null,
+                                 bic: null)
+```
+
+

data/docs/PayoutMethodDetailsIBAN.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **first_name** | **String** |  | 
 **last_name** | **String** |  | 
-**bank_name** | **String** |  | 
+**bank_name** | **String** |  | [optional] 
 **iban** | **String** |  | 
 **bic** | **String** |  | [optional] 
 

data/docs/Recipient.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **editable** | **Boolean** | Shows whether the recipient can be edited using the PATCH /v1/recipients/{id} endpoint or not | [optional] 
 **retriable** | **Boolean** | Shows whether the transaction made to the recipient can be retried or not | [optional] 
 **input_usd_amount** | **Float** | Shows how much this payment is worth in USD | [optional] 
-**may_cancel** | **Boolean** | Shows whether the payment can be cancelled using the DELETE /v1/recipients/{id} endpoint or not. The payment can not be cancelled if the payout is pending. | [optional] 
+**may_cancel** | **Boolean** | If true it shows that the payment can be cancelled immediately using the DELETE /v1/recipients/{id} endpoint. If false you can still try to cancel it, however it will only gets cancelled once we have confirmation from our partner that the payment has failed. | [optional] 
 **state_reason** | **String** | In case the payment is unsuccessful it holds the error message associated with the last unsuccessful payout. | [optional] 
 **state** | [**RecipientState**](RecipientState.md) |  | [optional] 
 **transaction_id** | **String** | The ID of the transaction that is related to this recipient | [optional] 

data/docs/RecipientsApi.md

@@ -14,7 +14,7 @@ Method | HTTP request | Description
 
 Cancelling a recipient
 
-Cancels the payment to the recipient specified in the URL path.  Please note only recipients where the `may_cancel` attribute is true can be cancelled.
+Cancels the payment to the recipient specified in the URL path.  Please note recipients where the `may_cancel` attribute is true will be cancelled immediately. If the `may_cancel` attribute is false you can still try to cancel the recipient, however it will only gets cancelled if we will receive a confirmation from our partner that the payment has failed
 
 ### Example
 ```ruby

data/docs/Sender.md

@@ -47,6 +47,7 @@ Name | Type | Description | Notes
 **onboarding_status** | **String** | The onboarding status of the sender | [optional] 
 **politically_exposed_people** | [**Array<PoliticallyExposedPerson>**](PoliticallyExposedPerson.md) | An optional list of politically exposed people, individuals who are or have been entrusted with prominent public functions by a country, for example heads of state or heads of government, senior politicians, senior government, judicial or military officials, senior executives of state owned corporations, important political party officials.  There is a limit of three (3) politically exposed people per Sender.  Politically exposed person example: ```json   {     \"politically_exposed_person\": {       \"name\": \"Ronald Reagan\",       \"position\": \"President of the United States\",       \"started_date\": \"1981-01-20T00:00:00.000Z\",       \"ended_date\": \"1989-01-20T00:00:00.000Z\",       \"sender_id\": \"344fb668-196d-43db-9d94-b34b7e6c7e0b\"     }   } ``` | [optional] 
 **external_id** | **String** | Optional ID that is supplied by partner linking it to the partner's own Sender ID. Note: if present we will validate whether the sent ID is a duplicate in our system or not. | [optional] 
+**created_at** | **String** | Date and time of sender was created | [optional] 
 
 ## Code Sample
 
@@ -95,7 +96,8 @@ instance = TransferZero::Sender.new(id: bf9ff782-e182-45ac-abea-5bce83ad6670,
                                  errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]},
                                  onboarding_status: null,
                                  politically_exposed_people: [{"id":"40","name":"Ronald Reagan","position":"President of the United States","started_date":"1981-01-20T00:00:00.000Z","ended_date":"1989-01-20T00:00:00.000Z","sender_id":"f9dc79ca-0c39-4add-9f4d-5ad7e6f187fb"}],
-                                 external_id: 806ec63a-a5a7-43cc-9d75-1ee74fbcc026)
+                                 external_id: 806ec63a-a5a7-43cc-9d75-1ee74fbcc026,
+                                 created_at: 2019-01-11T00:00:00.001+0000)
 ```
 
 

data/lib/transferzero-sdk.rb

@@ -64,6 +64,7 @@ require 'transferzero-sdk/models/payout_method_bank_account_type_enum'
 require 'transferzero-sdk/models/payout_method_details'
 require 'transferzero-sdk/models/payout_method_details_btc'
 require 'transferzero-sdk/models/payout_method_details_balance'
+require 'transferzero-sdk/models/payout_method_details_gbp_bank'
 require 'transferzero-sdk/models/payout_method_details_ghs_bank'
 require 'transferzero-sdk/models/payout_method_details_iban'
 require 'transferzero-sdk/models/payout_method_details_mad_cash'

data/lib/transferzero-sdk/api/recipients_api.rb

@@ -22,7 +22,7 @@ module TransferZero
 
 
     # Cancelling a recipient
-    # Cancels the payment to the recipient specified in the URL path.  Please note only recipients where the `may_cancel` attribute is true can be cancelled.
+    # Cancels the payment to the recipient specified in the URL path.  Please note recipients where the `may_cancel` attribute is true will be cancelled immediately. If the `may_cancel` attribute is false you can still try to cancel the recipient, however it will only gets cancelled if we will receive a confirmation from our partner that the payment has failed
     # @param recipient_id ID of recipient to cancel.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33`
     # @param [Hash] opts the optional parameters
     # @return [RecipientResponse]
@@ -32,7 +32,7 @@ module TransferZero
     end
 
     # Cancelling a recipient
-    # Cancels the payment to the recipient specified in the URL path.  Please note only recipients where the `may_cancel` attribute is true can be cancelled.
+    # Cancels the payment to the recipient specified in the URL path.  Please note recipients where the `may_cancel` attribute is true will be cancelled immediately. If the `may_cancel` attribute is false you can still try to cancel the recipient, however it will only gets cancelled if we will receive a confirmation from our partner that the payment has failed
     # @param recipient_id ID of recipient to cancel.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33`
     # @param [Hash] opts the optional parameters
     # @return [Array<(RecipientResponse, Fixnum, Hash)>] RecipientResponse data, response status code and response headers

data/lib/transferzero-sdk/api_client.rb

@@ -35,7 +35,7 @@ module TransferZero
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "TransferZero-SDK/Ruby/1.6.0"
+      @user_agent = "TransferZero-SDK/Ruby/1.7.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -106,12 +106,14 @@ module TransferZero
       url_with_params = add_query(url, query_params)
       form_params = opts[:form_params] || {}
 
+      request_body = opts[:body].to_s.gsub(/[[:space:]]+/, ' ').strip
+
       request_nonce = SecureRandom.uuid
       request_signature = sign_request([
         request_nonce,
         http_method.to_s.upcase,
         url_with_params,
-        DIGEST.hexdigest(opts[:body].to_s.gsub(/[[:space:]]+/, ' ').strip)
+        DIGEST.hexdigest(request_body)
       ])
 
       header_params['Authorization-Nonce'] = request_nonce
@@ -138,7 +140,7 @@ module TransferZero
       req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
 
       if [:post, :patch, :put, :delete].include?(http_method)
-        req_body = build_request_body(header_params, form_params, opts[:body])
+        req_body = build_request_body(header_params, form_params, request_body)
         req_opts.update :body => req_body
         if @config.debugging
           @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"

data/lib/transferzero-sdk/models/account.rb

@@ -13,86 +13,86 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-  class Account
-    # The account balance for the given currency
-    attr_accessor :amount
-
-    # The currency of this balance
-    attr_accessor :currency
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'amount' => :'amount',
-        :'currency' => :'currency'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'amount' => :'Float',
-        :'currency' => :'String'
-      }
-    end
+class Account
+  # The account balance for the given currency
+  attr_accessor :amount
+
+  # The currency of this balance
+  attr_accessor :currency
+
+  # Attribute mapping from ruby-style variable name to JSON key.
+  def self.attribute_map
+    {
+      :'amount' => :'amount',
+      :'currency' => :'currency'
+    }
+  end
 
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `TransferZero::Account` initialize method"
-      end
+  # Attribute type mapping.
+  def self.openapi_types
+    {
+      :'amount' => :'Float',
+      :'currency' => :'String'
+    }
+  end
 
-      # check to see if the attribute exists and convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `TransferZero::Account`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
-        end
-        h[k.to_sym] = v
-      }
+  # Initializes the object
+  # @param [Hash] attributes Model attributes in the form of hash
+  def initialize(attributes = {})
+    if (!attributes.is_a?(Hash))
+      fail ArgumentError, "The input argument (attributes) must be a hash in `TransferZero::Account` initialize method"
+    end
 
-      if attributes.key?(:'amount')
-        self.amount = attributes[:'amount']
+    # check to see if the attribute exists and convert string to symbol for hash key
+    attributes = attributes.each_with_object({}) { |(k, v), h|
+      if (!self.class.attribute_map.key?(k.to_sym))
+        fail ArgumentError, "`#{k}` is not a valid attribute in `TransferZero::Account`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
       end
+      h[k.to_sym] = v
+    }
 
-      if attributes.key?(:'currency')
-        self.currency = attributes[:'currency']
-      end
+    if attributes.key?(:'amount')
+      self.amount = attributes[:'amount']
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
+    if attributes.key?(:'currency')
+      self.currency = attributes[:'currency']
     end
+  end
 
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      true
-    end
+  # Show invalid properties with the reasons. Usually used together with valid?
+  # @return Array for valid properties with the reasons
+  def list_invalid_properties
+    invalid_properties = Array.new
+    invalid_properties
+  end
 
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          amount == o.amount &&
-          currency == o.currency
-    end
+  # Check to see if the all the properties in the model are valid
+  # @return true if the model is valid
+  def valid?
+    true
+  end
 
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
+  # Checks equality by comparing each attribute.
+  # @param [Object] Object to be compared
+  def ==(o)
+    return true if self.equal?(o)
+    self.class == o.class &&
+        amount == o.amount &&
+        currency == o.currency
+  end
 
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [amount, currency].hash
-    end
+  # @see the `==` method
+  # @param [Object] Object to be compared
+  def eql?(o)
+    self == o
+  end
+
+  # Calculates hash code according to all attributes.
+  # @return [Integer] Hash code
+  def hash
+    [amount, currency].hash
+  end
 
 require 'active_support/core_ext/hash'
 require 'active_support/hash_with_indifferent_access.rb'
@@ -208,5 +208,6 @@ def _to_hash(value)
   end
 end
 
-  end
+end
+
 end

data/lib/transferzero-sdk/models/account_list_response.rb

@@ -13,86 +13,86 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-  class AccountListResponse
-    attr_accessor :object
+class AccountListResponse
+  attr_accessor :object
 
-    attr_accessor :meta
+  attr_accessor :meta
 
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'object' => :'object',
-        :'meta' => :'meta'
-      }
-    end
+  # Attribute mapping from ruby-style variable name to JSON key.
+  def self.attribute_map
+    {
+      :'object' => :'object',
+      :'meta' => :'meta'
+    }
+  end
 
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'object' => :'Array<Account>',
-        :'meta' => :'AccountMeta'
-      }
-    end
+  # Attribute type mapping.
+  def self.openapi_types
+    {
+      :'object' => :'Array<Account>',
+      :'meta' => :'AccountMeta'
+    }
+  end
 
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `TransferZero::AccountListResponse` initialize method"
-      end
+  # Initializes the object
+  # @param [Hash] attributes Model attributes in the form of hash
+  def initialize(attributes = {})
+    if (!attributes.is_a?(Hash))
+      fail ArgumentError, "The input argument (attributes) must be a hash in `TransferZero::AccountListResponse` initialize method"
+    end
 
-      # check to see if the attribute exists and convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `TransferZero::AccountListResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
-        end
-        h[k.to_sym] = v
-      }
-
-      if attributes.key?(:'object')
-        if (value = attributes[:'object']).is_a?(Array)
-          self.object = value
-        end
+    # check to see if the attribute exists and convert string to symbol for hash key
+    attributes = attributes.each_with_object({}) { |(k, v), h|
+      if (!self.class.attribute_map.key?(k.to_sym))
+        fail ArgumentError, "`#{k}` is not a valid attribute in `TransferZero::AccountListResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
       end
+      h[k.to_sym] = v
+    }
 
-      if attributes.key?(:'meta')
-        self.meta = attributes[:'meta']
+    if attributes.key?(:'object')
+      if (value = attributes[:'object']).is_a?(Array)
+        self.object = value
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
+    if attributes.key?(:'meta')
+      self.meta = attributes[:'meta']
     end
+  end
 
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      true
-    end
+  # Show invalid properties with the reasons. Usually used together with valid?
+  # @return Array for valid properties with the reasons
+  def list_invalid_properties
+    invalid_properties = Array.new
+    invalid_properties
+  end
 
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          object == o.object &&
-          meta == o.meta
-    end
+  # Check to see if the all the properties in the model are valid
+  # @return true if the model is valid
+  def valid?
+    true
+  end
 
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
+  # Checks equality by comparing each attribute.
+  # @param [Object] Object to be compared
+  def ==(o)
+    return true if self.equal?(o)
+    self.class == o.class &&
+        object == o.object &&
+        meta == o.meta
+  end
 
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [object, meta].hash
-    end
+  # @see the `==` method
+  # @param [Object] Object to be compared
+  def eql?(o)
+    self == o
+  end
+
+  # Calculates hash code according to all attributes.
+  # @return [Integer] Hash code
+  def hash
+    [object, meta].hash
+  end
 
 require 'active_support/core_ext/hash'
 require 'active_support/hash_with_indifferent_access.rb'
@@ -208,5 +208,6 @@ def _to_hash(value)
   end
 end
 
-  end
+end
+
 end